home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / cshark53.zip / CS.DOC < prev    next >
Text File  |  1993-05-22  |  22KB  |  543 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                 Corporate Headquarters BBS (815) 886-3233                   ║
  4. ║                                            (815) 886-9381                   ║
  5. ║                                                                             ║
  6. ║                            C A R D   S H A R K S                            ║
  7. ║                                    v5.3                                     ║
  8. ║                                                                             ║
  9. ║                              MULTI-BBS Support                              ║
  10. ║       Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire, WWIV,        ║
  11. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  12. ║                                                                             ║
  13. ║                               Copyright 1993                                ║
  14. ║                               by Robert Neal                                ║
  15. ║                             317 Hickory Avenue                              ║
  16. ║                            Romeoville, IL  60441                            ║
  17. ║                                                                             ║
  18. ╚═════════════════════════════════════════════════════════════════════════════╝
  19.  
  20. |Changes to this documentation file from the previous version are
  21. |indicated by "|" in the left hand margin. This should make finding
  22. |changes to the documentation much easier and faster for those upgrading
  23. |from previous versions.
  24.  
  25. ATTENTION: Beginning with v5.0, the program incorporates new routines.
  26. Those upgrading from a prior release should note the new format for the
  27. configuration file. With these changes, the file BRUN45.EXE is no longer
  28. needed.
  29.  
  30. Card Sharks is released as SHAREWARE. You are granted a limited license to
  31. evaluate the program. Try it out, if you continue to use it you are required
  32. to register the program.
  33.  
  34. To register the program send $15.00 along with your name and BBS phone # to:
  35. Robert Neal, 317 Hickory Avenue, Romeoville, IL 60441.
  36.  
  37. The file CS.REG contained with this package must not be altered in anyway.
  38. Doing so will result in the program failing to operate. Once you register 
  39. the program you will be given your own personalized CS.REG file which will 
  40. show that the program is registered. BBS name supplied with payment will
  41. be the name 'imprinted' in the CS.REG file.
  42.  
  43.  
  44. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  45. CHARGE AND WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  46. LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  47. PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND
  48. PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL
  49. DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  50.  
  51.  
  52. Card Sharks is based on the TV show of the same name with some minor 
  53. variations. Each time the player is started with $200 to wager. He may
  54. bet any amount he desires up to the amount in his bank. The rules of play
  55. are pretty self explanitory and are displayed in the new player information
  56. screen of the game itself therefore I will not cover them here.
  57.  
  58. In addition to the initial $200 bank, for each row the player advances
  59. he is given another $200. On the last row the player is given the chance to
  60. bet his winnings from the current game PLUS the winnings he started the 
  61. game with in his bankroll.  The player must then bet atleast half of his
  62. entire bank on the last row (and last card). Note that the player is only
  63. given $200 each time he starts the game, he is not given his entire bankroll
  64. to play the game, only for the final card.
  65.  
  66. On the final card, if the user hangs up without placing a wager on the top
  67. card, the program will automatically take half of his bankroll. I've seen
  68. where some users, in an attempt to play it safe, will hang up rather than
  69. play out the last card (especially if it's an 7, 8, etc.). This should keep
  70. the game more honest for everyone.
  71.  
  72.  
  73.  
  74. FEATURES OF CARD SHARKS
  75.  
  76.   -  Easy to install and requires no maintenance.
  77.  
  78.   -  Ansi color support.
  79.  
  80.   -  Terminates cleanly through exit code even on runtime error.
  81.  
  82.   -  Automatically creates a top score listing suitable for inclusion
  83.      as a text/bulletin file for display within your BBS. 
  84.  
  85.   -  Detects loss of carrier.
  86.  
  87.   -  Operates in local mode (either direct from BBS or from command line).
  88.  
  89.   -  Sysop function keys to return to the board, chat mode, user stats,
  90.      increase/decrease time, etc.
  91.  
  92.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS, WWIV,
  93.      Ultra BBS, Telegard, TriTel and Remote Access.
  94.  
  95.   -  Support for baud rates up to 115,200
  96.  
  97. | -  Support for COM0-15. Optional command line for non-standard IRQ's.
  98.  
  99.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  100.  
  101.   -  Support Fossil Drivers. A Fossil driver is not required to use the
  102.      program.
  103.  
  104.   -  Fully Multi-Node compatible.
  105.  
  106.  
  107.  
  108. FIRST TIME OPERATIONS
  109.  
  110. If you are setting up a game for the first time you MUST pass the command
  111. parameter "NEW" to the program so that it will create the necessary files,
  112. ie. CS NEW. This is the only time that you need to pass this parameter,
  113. but you may use it to restart a game before the monthly maintenance. Note
  114. that passing the 'NEW' parameter will NOT cause the current high score file
  115. TOPCS to be converted to the TOPOLD file.
  116.  
  117. The 'NEW' will wipe out all current files, so be sure you want to 'NEW'
  118. the game before using it.
  119.  
  120.  
  121.  
  122.  
  123. AUTOMATIC MAINTENANCE
  124.  
  125. The program will automatically during the first play of each new month
  126. reset it's user file and top score listing. The previous months top score
  127. |listing (TOPCS) will automatically be renamed to TOPOLD. This  can then
  128. be included as a text file to display the previous months winners.
  129.  
  130. You should be aware of this so if you are starting a new game for the
  131. first time towards the end of the month, the game will automatically perform
  132. the maintenace come the first of the month.
  133.  
  134.  
  135.  
  136. CONFIGURING THE PROGRAM
  137.  
  138. New with v5.1 is a program called CSCONFIG.EXE. You may use this program
  139. to create and/or edit the configuration files. To use CSCONFIG, type
  140. CSCONFIG CS.CFG. This editor will allow you to enter the appropriate
  141. configuration editor within it's own full screen editor as well as edit
  142. the CS.TXT file. Below is the layout of the CS.CFG file if you wish to
  143. edit it manually.
  144.  
  145. C:\PCB\PCBOARD.SYS
  146. Corporate Headquarters
  147. Bob
  148. Neal
  149. 3
  150. 100
  151. NOBANKRUPT
  152.  
  153. Line 1 = Full pathname of your door file. Formats supported by this
  154.          program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  155.                       CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  156.                       CHAIN.TXT. When using USERINFO.DAT, DOOR.SYS
  157.                       must be in the same directory as USERINFO.DAT.
  158. Line 2 = BBS name
  159. Line 3 = Sysop First Name
  160. Line 4 = Sysop Last Name
  161. Line 5 = number of times per day that a player may play the game
  162.          if you do not wish to limit the number of daily plays enter
  163.          a large number (999 for example). I would suggest the a daily
  164.          limit be used (3 is a good number to use) so as to prevent
  165.          some users from running up the scores.
  166. Line 6 = Probability of a Joker being added to the deck. This is a new
  167.          option in v5.1. Enter 100 if you want 1 joker added (100%
  168.          probablility), enter 200 for 2 jokers or you may enter 50 to
  169.          have a 50% probability that a joker would be hit. Do not set
  170.          this value to high otherwise the users may get tired of
  171.          seeing the joker pop up. I recommend a value between 50-100.
  172. Line 7 = Another new feature with v5.1. You can set the option to either
  173.          bankrupt the player (the entire bankroll is lost) or just the
  174.          turns remaining for that day if the joker is hit. Enter either
  175.          BANKRUPT or NOBANKRUPT - I recommend NOBANKRUPT.
  176.  
  177.  
  178.  
  179. Note: This door supports the PCBoard environment variables %PCBDRIVE%
  180. and %PCBDIR%. Non-PCBoard systems may also use these variables by
  181. including the following either in your BBS batch or AUTOEXEC.BAT file:
  182.  
  183.     SET PCBDRIVE=C:            <- Drive letter of your BBS files
  184.     SET PCBDIR=\BBS            <- Path of your BBS files
  185.  
  186. Then, in your CS.CFG file, on the first line you may put:
  187.  
  188.    %PCBDRIVE%%PCBDIR%\PCBOARD.SYS, %PCBDRIVE%%PCBDIR%\DOOR.SYS, etc.
  189.  
  190. This allows you to use just one .CFG file for multi-node operation.
  191.  
  192.  
  193.  
  194. EXECUTING PROGRAM
  195.  
  196. To execute the program, enter the filename followed by the config file
  197. name (ie CS.EXE CS.CFG). If you are running the program from the command
  198. line, you may optionally enter CS.EXE LOCAL. The only problem with this
  199. is the default user name sysop is used instead of the name on your board.
  200. This is good for testing the game before putting it on your system, but
  201. you should once play begins, execute the program locally from your BBS or
  202. consistantly run the game from the command line when you play.
  203.  
  204. You may also specify a non-standard IRQ. Put the IRQ number after the
  205. .CFG on the command line. For example: CS CS.CFG /5. This example tells
  206. the program to use IRQ 5 instead of the standard IRQ.
  207.  
  208. You may also use the procedure above and create a variable IRQ so that
  209. you can pass the IRQ setting as: CS CS.CFG /%IRQ%
  210.  
  211. |Some users may have had conflicts when using non-standard IRQ's on
  212. |Novell/Netware systems. Novell seems to use the "/" character for
  213. |parameter passing. You may not optionally use the "*" character instead
  214. |of the "/", for example CS CS.CFG *%IRQ% is valid. Both "*" and "/"
  215. |will work.
  216.  
  217.  
  218. You also have the option of running the game as 'stand alone' (without a
  219. BBS). To do so, type CS.EXE NOBBS. You will now be prompted to enter
  220. your name. This is useful for testing the program offline for sysops and
  221. have had people find this useful to play as a non-BBS door.
  222.  
  223. FOSSIL DRIVER
  224. =============
  225.  
  226. Card Sharks now includes support for FOSSIL drivers. This means that the
  227. program will now work with Digiboard (for Wildcat M and PCBoard/M
  228. versions) and other multi-port boards. To activate the Fossil driver
  229. support just include /FD on the command line in your door batch file.
  230.  
  231.         For example: CS CS.CFG /FD
  232.  
  233. If no Fossil driver is available, Card Sharks will display a message
  234. indicating such and exit cleanly.
  235.  
  236.  
  237.  
  238. This documentation will not go into the mechanics of how you set-up a door
  239. program on your BBS. It is assumed that you have a working knowledge of
  240. how to complete this task.
  241.  
  242.  
  243. SYSOP KEYS ACTIVE
  244.  
  245. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  246.          written to DOOR.SYS and USERS.SYS
  247. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  248.          and/or written to DOOR.SYS and USERS.SYS
  249. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  250. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  251.          and/or written to DOOR.SYS and USERS.SYS
  252. F8    -  Returns the caller involuntarily to the BBS.
  253. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  254.          and/or written to DOOR.SYS and USERS.SYS
  255. F10   -  Activates SysOp CHAT mode within the DOOR.
  256. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  257. UP    -  Give the caller extra time while in the DOOR.  
  258. DN    -  Subtract time from the caller while in the DOOR. 
  259. HOME  -  HELP key for Status Line options.
  260. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  261. ALT-X -  PCBoard will exit after current caller logs off. Value is
  262.          passed to PCBoard. Not available on non-PCBoard systems.
  263.  
  264.  
  265.  
  266.  
  267. FILES USED AND CREATED
  268.  
  269. CS.EXE - The program itself (may want to rename to CS.EXE)
  270. CS.DOC  - Documentation for the sysop to run Card Sharks
  271. CS.REG   - File which shows who 'owns' (registered) the game
  272.            MUST NOT BE ALTERED
  273. CS.CFG   - Configuration file
  274. CS.TXT   - Option text file with comments for winning and losing. This
  275.            file will only be read by REGISTERED versions of Card Sharks.
  276.  
  277.  
  278. The following files will be created by Card Sharks
  279.  
  280. CARDSHRK.USR - User file of current players
  281. |TOPCS       - Top scores in ascii format can be used as a bulletin
  282. |TOPCSG      - Top scores in ansi format can be used as a bulletin
  283. |TOP.CS      - Top scores data file
  284. |TOPOLD      - Previous months ascii score listing, created at the
  285.                 beginning of each new month
  286. |TOPOLDG     - Previous months ansi score listing, created at the
  287.                 beginning of each new month
  288. HISCORE.CS   - Data file with name and amount of highest earnings ever.
  289.  
  290.  
  291. THE GAME ITSELF
  292.  
  293. The game starts by displaying the Card Sharks opening screen (please do not
  294. modify this or any other part of the game), and will ask the user if he 
  295. wants to use ANSI colors. While the BBS door info file passes the variable for
  296. if a user has ANSI on or off, this gives those players a chance who may have
  297. ANSI off for normal BBS useage to use ANSI colors while in the door.
  298.  
  299. From here, if the player is a new player he is informed of the rules of play
  300. and his account in established. If he is a current player he will be shown
  301. his player stats right away (last time on, bankroll, etc) and then play
  302. will begin. The users stats are updated after each guess (right or wrong)
  303. so as to prevent callers from disconnecting if the hit bankrupt on a bad
  304. guess.
  305.  
  306. Play continues until the players bank account hits zero or the last card 
  307. is played.  The top score listing is then updated with the new standings.
  308.  
  309.  
  310.  
  311. CONTACT ME FOR SUPPORT
  312.  
  313. If you encounter any problems you may contact me at Corporate Headquarters
  314. BBS (815) 886-3233 or (815) 886-9381.
  315.  
  316. If you have any suggestions for improvements for this program, please feel
  317. free to let me know. This game has included suggestions from users of my
  318. BBS as well as the beta testing BBS.
  319.  
  320.  
  321.  
  322. VERSION HISTORY
  323.  
  324.  
  325. Version 3.0 (02/15/89)
  326.  
  327. While Card Sharks has been available for play on my BBS for over a year,
  328. this is the first attempt at releasing a completely standalone program for
  329. others use.
  330.  
  331.  
  332. Version 3.1 (03/01/89)
  333.  
  334. Fixed several bugs including a problem with the program in rolling over
  335. the previous months scores. The game would rollover the scores fine the
  336. first month, but subsequent rollovers caused the game to go into a 
  337. screeching halt. With this fix also comes improved error handling so that
  338. if something else quirky does arise the program will exit gracefully back
  339. to the BBS instead of just dieing.
  340.  
  341. Fixed a minor problem with the input of using 'H'alf of bank. If a person
  342. had only $1 the program would round the bet down to zero. Now if the person
  343. has only $1 left to wager, half the bet would be the $1 remaining.
  344.  
  345. Added a new file CS.REG which contains information on whom the program is
  346. registered. Unregistered programs are given the default file that labels
  347. the program as being unregistered. Failure to keep this program in the
  348. same directory as the Card Sharks program itself or altering this file
  349. will result in the game refusing to operate. This 'feature' makes it 
  350. very simple for me to pass along a registered 'copy' to those who register
  351. as all I need to do is hand out their own personalized CS.REG file.
  352.  
  353.  
  354.  
  355. Version 3.2  (05/05/89)
  356.  
  357. Once again the problem with the previous months scoreboard rolling over
  358. has appeared. Seems that the problem only occurs when a remote call is
  359. the first call of the month. If the sysop was the first call (locally)
  360. the rollover worked fine. I have once again reworked the code and hope
  361. this is the final time to call out the pest control for this problem.
  362.  
  363. Changed the program so that the sysop must now pass the parameter 'new'
  364. to initialize a new game. Passing the parameter 'NEW', ie. CS NEW,
  365. will cause the game to create new data files for the game. 
  366.  
  367. Also added some more color to the game by now displaying the card numbers
  368. and suites in a different color than the card itself.
  369.  
  370.  
  371. Version 3.3  (06/01/89)
  372.  
  373. The bug with the rollover still managed to appear, but this time it's
  374. next to guaranteed that the monthly score rollovers will work without
  375. fail. A conflict between my code and the CatPatch routines made it
  376. difficult to uncover. This function has now been tested and retested to
  377. ensure proper handling of the routine.
  378.  
  379. Expanded the scoreboard field to allow well over a ZILLION points to be
  380. displayed. Yes, it happened, a real duel was underway with two players
  381. rolling their scores into the zillions on my board.
  382.  
  383.  
  384.  
  385. Version 4.0  (09/22/89)
  386.  
  387. First off, there have been no problems reported with the monthly rollover
  388. of the scoreboard. Told you is was nearly guaranteed that it would work
  389. properly this time.
  390.  
  391. Added option to run as a non-BBS program (stand alone).
  392.  
  393. Enhanced the display to show actual suit cards (a club, heart, spade
  394. and diamond) instead of 'C', 'H','S' and 'D' respectively if the user
  395. selects ANSI graphics display.
  396.  
  397. Added multi-BBS support to allow Card Sharks to be run on PCBoard v14.x,
  398. QBBS, RBBS 15.1c and of course Wildcat.
  399.  
  400. Recoded the card display option to update only the card changed. Previously
  401. if a user changed the card after jumping to the next row the last card
  402. on the previous row was also changed.
  403.  
  404. Found that some users would rather hang up after seeing the top card rather
  405. than take a chance of loosing half their bankroll. Well that has now been
  406. fixed in this version as the program will automatically take half their
  407. bankroll if they decide to hang up instead of playing the card shown.
  408.  
  409. For those who are upgrading to the new version, you need not change anything
  410. you now have set-up. Just copy the CS40.EXE file into the proper directory.
  411.  
  412.  
  413. Version 4.1 (04/28/90)
  414.  
  415. Added support for WWIV (CHAIN.TXT) file format.
  416.  
  417. Revised scoreboard to include highest ever earnings in Card Sharks as
  418. well as average earnings per play.
  419.  
  420. Added option where user can remain in door and play out as many turns
  421. as he has left. For example if you allow 3 plays per day, the user no
  422. longer is forced to return to the board after each play. If he has 1 or
  423. more turns left for the day he is prompted if he wants to play another
  424. round.
  425.  
  426. Again, if upgrading just copy the CS41.EXE file into the proper
  427. directory.
  428.  
  429.  
  430. Version 4.2 (Added support for Spitfire BBS)
  431.  
  432.  
  433. Version 4.3 (08/13/90)
  434.  
  435. Limited release version for beta testing new routines for high speed HST
  436. modems.
  437.  
  438.  
  439. Version 4.4 (08/25/90)
  440.  
  441. Resolved problem with high speed modems (9600+ baud). Beta testers have
  442. reported that program now operates fine at high speed modes.
  443.  
  444. Changed compiler to latest version, v4.5 of Quick Basic. Program now
  445. requires use of patch BRUN45.EXE program. Program is distributed with
  446. this program.
  447.  
  448.  
  449. v4.5
  450.  
  451. Internal version, minor changes, never released.
  452.  
  453.  
  454.  
  455. v4.6 (08/04/92)
  456.  
  457. Revised I/O routines to accomodate changes to several file formats.
  458.  
  459. Revised I/O routines for RBBS systems. Seems the format has been
  460. changed slightly when running local doors. Fixed problem, thanks to
  461. Rob Engle for his assistance with resolving this problem.
  462.  
  463. Added new option, "B" for all but a BUCK. Many times, users will want
  464. to bet almost all they have on a card (3,4,Q,K). This lets them bet all
  465. but $1 of their total bank.
  466.  
  467. Revised scoreboard, deleting average $ per play and replaced with # of
  468. plays and date last played. Helpful for users who are in competition
  469. with another user to know if they have played recently.
  470.  
  471. Changed display character for the club if in color mode. Seems that the
  472. Compuserve system uses that as their file transfer start character,
  473. users who had AUTO COMPUSERVE ON were getting +0+0's popping up when the
  474. club was displayed. The character selected isn't as "cute", but better
  475. than +0's being displayed.
  476.  
  477.  
  478. v5.0 (08/23/92)
  479.  
  480. Underwent a major upgrade in the I/O routines. This door now supports baud
  481. rates up to 115,200 and COM1-4 (plus non-standard IRQ's). This should help
  482. those who lock their baud rates at 38,400 and above. In addition, these new
  483. routines should allow the program to be run under DesqView. Please note, those
  484. who are upgrading from a prior version should review the new configuration
  485. file format. This door is now released as a completely stand-alone
  486. program, no longer requiring the BRUN45.EXE file.
  487.  
  488.  
  489. v5.1  (10/18/92)
  490.  
  491. Many ideas have been suggested for improving Card Sharks. I've taken
  492. several comments and implemented the following changes:
  493.  
  494. Added option to add a JOKER to the deck.
  495.  
  496. Added option to either BANKRUPT player or lose turns remaining for the
  497. day if Joker is hit.
  498.  
  499. Added option for sysop to include their own WINNING and LOSING comments
  500. in the file CS.TXT (registered version only)
  501.  
  502. Improvement in the screen displays.
  503.  
  504. Improved CHAT routine - now restores upon return.
  505.  
  506. Revised routines to not display scoreboard twice during replays.
  507.  
  508. Minor screen revisions.
  509.  
  510. Fixed problem with upper case input -  now accepts both upper and
  511. lower case input without a problem.
  512.  
  513.  
  514. v5.2 (11/11/92)
  515.  
  516. New support for FOSSIL drivers (see section on FOSSIL DRIVERS above for
  517. details).
  518.  
  519. Screen displays have again been optimized, screen displays are faster
  520. than previous versions.
  521.  
  522. v5.3 (05/22/93)
  523.  
  524. Enhanced the top player scoreboard display as well as increased number
  525. of players included in the scoreboard from 5 to 10. The bulletin
  526. filenames have been changed, Card Sharks will automatically handle any
  527. conversion of this file information the first time it is run. You may
  528. need to change your bulletin information on your BBS to reflect these
  529. new filenames, refer to documentation above for filename conventions.
  530.  
  531.  
  532.  
  533. DISTRIBUTION SITES:
  534.  
  535.    As always you can find the latest version of Card Sharks available for
  536.    downloading from Corporate Headquarters BBS.
  537.  
  538.    Calls for support for Card Sharks should be directed only to
  539.    Corporate Headquarters BBS.
  540.  
  541.    Corporate Headquarters BBS   (815) 886-3233  (14400 v.32bis)
  542.                                       886-9381  (14400 v.32bis)
  543.